API docs by Redocly

NRF NFManagement Service (1.2.9)

Download OpenAPI specification:

NRF NFManagement Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.510 V17.16.0; 5G System; Network Function Repository Services; Stage 3

NF Instances (Store)

Retrieves a collection of NF Instances

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
query Parameters
string or string (NFType)

Type of NF

limit
integer >= 1

How many items to return at one time

page-number
integer >= 1

Page number where the response shall start

page-size
integer >= 1

Maximum number of items in each returned page

Responses

Response samples

Content type
application/3gppHal+json
{
  • "_links": {
    },
  • "totalItemCount": 0
}

Discover communication options supported by NRF for NF Instances

Authorizations:
NoneoAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "supportedFeatures": "string"
}

NF Instance ID (Document)

Read the profile of a given NF Instance

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
nfInstanceID
required
string <uuid> (NfInstanceId)

Unique ID of the NF Instance

query Parameters
requester-features
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features supported by the NF Service Consumer

Responses

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "nfInstanceName": "string",
  • "nfType": "NRF",
  • "nfStatus": "REGISTERED",
  • "collocatedNfInstances": [
    ],
  • "heartBeatTimer": 1,
  • "plmnList": [
    ],
  • "snpnList": [
    ],
  • "sNssais": [
    ],
  • "perPlmnSnssaiList": [
    ],
  • "nsiList": [
    ],
  • "fqdn": "string",
  • "interPlmnFqdn": "string",
  • "ipv4Addresses": [
    ],
  • "ipv6Addresses": [
    ],
  • "allowedPlmns": [
    ],
  • "allowedSnpns": [
    ],
  • "allowedNfTypes": [
    ],
  • "allowedNfDomains": [
    ],
  • "allowedNssais": [
    ],
  • "priority": 65535,
  • "capacity": 65535,
  • "load": 100,
  • "loadTimeStamp": "2019-08-24T14:15:22Z",
  • "locality": "string",
  • "udrInfo": {
    },
  • "udrInfoList": {
    },
  • "udmInfo": {
    },
  • "udmInfoList": {
    },
  • "ausfInfo": {
    },
  • "ausfInfoList": {
    },
  • "amfInfo": {
    },
  • "amfInfoList": {
    },
  • "smfInfo": {
    },
  • "smfInfoList": {
    },
  • "upfInfo": {
    },
  • "upfInfoList": {
    },
  • "pcfInfo": {
    },
  • "pcfInfoList": {
    },
  • "bsfInfo": {
    },
  • "bsfInfoList": {
    },
  • "chfInfo": {
    },
  • "chfInfoList": {
    },
  • "nefInfo": {
    },
  • "nrfInfo": {
    },
  • "udsfInfo": {
    },
  • "udsfInfoList": {
    },
  • "nwdafInfo": {
    },
  • "nwdafInfoList": {
    },
  • "pcscfInfoList": {
    },
  • "hssInfoList": {
    },
  • "customInfo": { },
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "nfServicePersistence": false,
  • "nfServices": [
    ],
  • "nfServiceList": {
    },
  • "nfProfileChangesInd": false,
  • "defaultNotificationSubscriptions": [
    ],
  • "lmfInfo": {
    },
  • "gmlcInfo": {
    },
  • "nfSetIdList": [
    ],
  • "servingScope": [
    ],
  • "lcHSupportInd": false,
  • "olcHSupportInd": false,
  • "nfSetRecoveryTimeList": {
    },
  • "serviceSetRecoveryTimeList": {
    },
  • "scpDomains": [
    ],
  • "scpInfo": {
    },
  • "seppInfo": {
    },
  • "vendorId": "string",
  • "supportedVendorSpecificFeatures": {
    },
  • "aanfInfoList": {
    },
  • "5gDdnmfInfo": {
    },
  • "mfafInfo": {
    },
  • "easdfInfoList": {
    },
  • "dccfInfo": {
    },
  • "nsacfInfoList": {
    },
  • "mbSmfInfoList": {
    },
  • "tsctsfInfoList": {
    },
  • "mbUpfInfoList": {
    },
  • "trustAfInfo": {
    },
  • "nssaafInfo": {
    },
  • "hniList": [
    ],
  • "iwmscInfo": {
    },
  • "mnpfInfo": {
    }
}

Register a new NF Instance

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
nfInstanceID
required
string <uuid> (NfInstanceId)

Unique ID of the NF Instance to register

header Parameters
Content-Encoding
string

Content-Encoding, described in IETF RFC 7231

Accept-Encoding
string

Accept-Encoding, described in IETF RFC 7231

Request Body schema: application/json
required
Any of
nfInstanceId
required
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

nfInstanceName
string
required
string or string (NFType)

NF types known to NRF

required
string or string (NFStatus)

Status of a given NF Instance stored in NRF

Array of objects (CollocatedNfInstance) non-empty
heartBeatTimer
integer >= 1
Array of objects (PlmnId) non-empty
Array of objects (PlmnIdNid) non-empty
Array of objects (ExtSnssai) non-empty
Array of objects (PlmnSnssai) non-empty
nsiList
Array of strings non-empty
fqdn
required
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

interPlmnFqdn
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

ipv4Addresses
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]
ipv6Addresses
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]
Array of objects (PlmnId) non-empty
Array of objects (PlmnIdNid) non-empty
Array of strings or strings (NFType) non-empty
allowedNfDomains
Array of strings non-empty
Array of objects (ExtSnssai) non-empty
priority
integer [ 0 .. 65535 ]
capacity
integer [ 0 .. 65535 ]
load
integer [ 0 .. 100 ]
loadTimeStamp
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

locality
string
object (UdrInfo)

Information of an UDR NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of UdrInfo

object (UdmInfo)

Information of an UDM NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of UdmInfo

object (AusfInfo)

Information of an AUSF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of AusfInfo

object (AmfInfo)

Information of an AMF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of AmfInfo

object (SmfInfo)

Information of an SMF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of SmfInfo

object (UpfInfo)

Information of an UPF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of UpfInfo

object (PcfInfo)

Information of a PCF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of PcfInfo

object (BsfInfo)

Information of a BSF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of BsfInfo

object (ChfInfo)

Information of a CHF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of ChfInfo

object (NefInfo)

Information of an NEF NF Instance

object (NrfInfo)

Information of an NRF NF Instance, used in hierarchical NRF deployments

object (UdsfInfo)

Information related to UDSF

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of UdsfInfo

object (NwdafInfo)

Information of a NWDAF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of NwdafInfo

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of PcscfInfo

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of HssInfo

customInfo
object
recoveryTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

nfServicePersistence
boolean
Default: false
Array of objects (NFService) non-empty
Deprecated
object non-empty

A map (list of key-value pairs) where serviceInstanceId serves as key of NFService

nfProfileChangesSupportInd
boolean
Default: false
Array of objects (DefaultNotificationSubscription)
object (LmfInfo)

Information of an LMF NF Instance

object (GmlcInfo)

Information of a GMLC NF Instance

nfSetIdList
Array of strings (NfSetId) non-empty
servingScope
Array of strings non-empty
lcHSupportInd
boolean
Default: false
olcHSupportInd
boolean
Default: false
object non-empty

A map (list of key-value pairs) where NfSetId serves as key of DateTime

object non-empty

A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime

scpDomains
Array of strings non-empty
object (ScpInfo)

Information of an SCP Instance

object (SeppInfo)

Information of a SEPP Instance

vendorId
string (VendorId) ^[0-9]{6}$

Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA)

object non-empty

The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of AanfInfo

object (5GDdnmfInfo)

Information of an 5G DDNMF NF Instance

object (MfafInfo)

Information of a MFAF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of EasdfInfo

object (DccfInfo)

Information of a DCCF NF Instance

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of NsacfInfo

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of MbSmfInfo

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of TsctsfInfo

object non-empty

A map (list of key-value pairs) where a (unique) valid JSON string serves as key of MbUpfInfo

object (TrustAfInfo)

Information of a trusted AF Instance

object (NssaafInfo)

Information of a NSSAAF Instance

hniList
Array of strings (Fqdn) non-empty [ items [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... ]
object (IwmscInfo)

Information of an SMS-IWMSC NF Instance

object (MnpfInfo)

Information of an MNPF Instance

Responses

Request samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "nfInstanceName": "string",
  • "nfType": "NRF",
  • "nfStatus": "REGISTERED",
  • "collocatedNfInstances": [
    ],
  • "heartBeatTimer": 1,
  • "plmnList": [
    ],
  • "snpnList": [
    ],
  • "sNssais": [
    ],
  • "perPlmnSnssaiList": [
    ],
  • "nsiList": [
    ],
  • "fqdn": "string",
  • "interPlmnFqdn": "string",
  • "ipv4Addresses": [
    ],
  • "ipv6Addresses": [
    ],
  • "allowedPlmns": [
    ],
  • "allowedSnpns": [
    ],
  • "allowedNfTypes": [
    ],
  • "allowedNfDomains": [
    ],
  • "allowedNssais": [
    ],
  • "priority": 65535,
  • "capacity": 65535,
  • "load": 100,
  • "loadTimeStamp": "2019-08-24T14:15:22Z",
  • "locality": "string",
  • "udrInfo": {
    },
  • "udrInfoList": {
    },
  • "udmInfo": {
    },
  • "udmInfoList": {
    },
  • "ausfInfo": {
    },
  • "ausfInfoList": {
    },
  • "amfInfo": {
    },
  • "amfInfoList": {
    },
  • "smfInfo": {
    },
  • "smfInfoList": {
    },
  • "upfInfo": {
    },
  • "upfInfoList": {
    },
  • "pcfInfo": {
    },
  • "pcfInfoList": {
    },
  • "bsfInfo": {
    },
  • "bsfInfoList": {
    },
  • "chfInfo": {
    },
  • "chfInfoList": {
    },
  • "nefInfo": {
    },
  • "nrfInfo": {
    },
  • "udsfInfo": {
    },
  • "udsfInfoList": {
    },
  • "nwdafInfo": {
    },
  • "nwdafInfoList": {
    },
  • "pcscfInfoList": {
    },
  • "hssInfoList": {
    },
  • "customInfo": { },
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "nfServicePersistence": false,
  • "nfServices": [
    ],
  • "nfServiceList": {
    },
  • "nfProfileChangesSupportInd": false,
  • "defaultNotificationSubscriptions": [
    ],
  • "lmfInfo": {
    },
  • "gmlcInfo": {
    },
  • "nfSetIdList": [
    ],
  • "servingScope": [
    ],
  • "lcHSupportInd": false,
  • "olcHSupportInd": false,
  • "nfSetRecoveryTimeList": {
    },
  • "serviceSetRecoveryTimeList": {
    },
  • "scpDomains": [
    ],
  • "scpInfo": {
    },
  • "seppInfo": {
    },
  • "vendorId": "string",
  • "supportedVendorSpecificFeatures": {
    },
  • "aanfInfoList": {
    },
  • "5gDdnmfInfo": {
    },
  • "mfafInfo": {
    },
  • "easdfInfoList": {
    },
  • "dccfInfo": {
    },
  • "nsacfInfoList": {
    },
  • "mbSmfInfoList": {
    },
  • "tsctsfInfoList": {
    },
  • "mbUpfInfoList": {
    },
  • "trustAfInfo": {
    },
  • "nssaafInfo": {
    },
  • "hniList": [
    ],
  • "iwmscInfo": {
    },
  • "mnpfInfo": {
    }
}

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "nfInstanceName": "string",
  • "nfType": "NRF",
  • "nfStatus": "REGISTERED",
  • "collocatedNfInstances": [
    ],
  • "heartBeatTimer": 1,
  • "plmnList": [
    ],
  • "snpnList": [
    ],
  • "sNssais": [
    ],
  • "perPlmnSnssaiList": [
    ],
  • "nsiList": [
    ],
  • "fqdn": "string",
  • "interPlmnFqdn": "string",
  • "ipv4Addresses": [
    ],
  • "ipv6Addresses": [
    ],
  • "allowedPlmns": [
    ],
  • "allowedSnpns": [
    ],
  • "allowedNfTypes": [
    ],
  • "allowedNfDomains": [
    ],
  • "allowedNssais": [
    ],
  • "priority": 65535,
  • "capacity": 65535,
  • "load": 100,
  • "loadTimeStamp": "2019-08-24T14:15:22Z",
  • "locality": "string",
  • "udrInfo": {
    },
  • "udrInfoList": {
    },
  • "udmInfo": {
    },
  • "udmInfoList": {
    },
  • "ausfInfo": {
    },
  • "ausfInfoList": {
    },
  • "amfInfo": {
    },
  • "amfInfoList": {
    },
  • "smfInfo": {
    },
  • "smfInfoList": {
    },
  • "upfInfo": {
    },
  • "upfInfoList": {
    },
  • "pcfInfo": {
    },
  • "pcfInfoList": {
    },
  • "bsfInfo": {
    },
  • "bsfInfoList": {
    },
  • "chfInfo": {
    },
  • "chfInfoList": {
    },
  • "nefInfo": {
    },
  • "nrfInfo": {
    },
  • "udsfInfo": {
    },
  • "udsfInfoList": {
    },
  • "nwdafInfo": {
    },
  • "nwdafInfoList": {
    },
  • "pcscfInfoList": {
    },
  • "hssInfoList": {
    },
  • "customInfo": { },
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "nfServicePersistence": false,
  • "nfServices": [
    ],
  • "nfServiceList": {
    },
  • "nfProfileChangesInd": false,
  • "defaultNotificationSubscriptions": [
    ],
  • "lmfInfo": {
    },
  • "gmlcInfo": {
    },
  • "nfSetIdList": [
    ],
  • "servingScope": [
    ],
  • "lcHSupportInd": false,
  • "olcHSupportInd": false,
  • "nfSetRecoveryTimeList": {
    },
  • "serviceSetRecoveryTimeList": {
    },
  • "scpDomains": [
    ],
  • "scpInfo": {
    },
  • "seppInfo": {
    },
  • "vendorId": "string",
  • "supportedVendorSpecificFeatures": {
    },
  • "aanfInfoList": {
    },
  • "5gDdnmfInfo": {
    },
  • "mfafInfo": {
    },
  • "easdfInfoList": {
    },
  • "dccfInfo": {
    },
  • "nsacfInfoList": {
    },
  • "mbSmfInfoList": {
    },
  • "tsctsfInfoList": {
    },
  • "mbUpfInfoList": {
    },
  • "trustAfInfo": {
    },
  • "nssaafInfo": {
    },
  • "hniList": [
    ],
  • "iwmscInfo": {
    },
  • "mnpfInfo": {
    }
}

Update NF Instance profile

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
nfInstanceID
required
string <uuid> (NfInstanceId)

Unique ID of the NF Instance to update

header Parameters
Content-Encoding
string

Content-Encoding, described in IETF RFC 7231

Accept-Encoding
string

Accept-Encoding, described in IETF RFC 7231

If-Match
string

Validator for conditional requests, as described in IETF RFC 7232, 3.2

Request Body schema: application/json-patch+json
required
Array (non-empty)
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "nfInstanceId": "bef4e5a3-4b03-48b3-a176-c7ae2a79cac4",
  • "nfInstanceName": "string",
  • "nfType": "NRF",
  • "nfStatus": "REGISTERED",
  • "collocatedNfInstances": [
    ],
  • "heartBeatTimer": 1,
  • "plmnList": [
    ],
  • "snpnList": [
    ],
  • "sNssais": [
    ],
  • "perPlmnSnssaiList": [
    ],
  • "nsiList": [
    ],
  • "fqdn": "string",
  • "interPlmnFqdn": "string",
  • "ipv4Addresses": [
    ],
  • "ipv6Addresses": [
    ],
  • "allowedPlmns": [
    ],
  • "allowedSnpns": [
    ],
  • "allowedNfTypes": [
    ],
  • "allowedNfDomains": [
    ],
  • "allowedNssais": [
    ],
  • "priority": 65535,
  • "capacity": 65535,
  • "load": 100,
  • "loadTimeStamp": "2019-08-24T14:15:22Z",
  • "locality": "string",
  • "udrInfo": {
    },
  • "udrInfoList": {
    },
  • "udmInfo": {
    },
  • "udmInfoList": {
    },
  • "ausfInfo": {
    },
  • "ausfInfoList": {
    },
  • "amfInfo": {
    },
  • "amfInfoList": {
    },
  • "smfInfo": {
    },
  • "smfInfoList": {
    },
  • "upfInfo": {
    },
  • "upfInfoList": {
    },
  • "pcfInfo": {
    },
  • "pcfInfoList": {
    },
  • "bsfInfo": {
    },
  • "bsfInfoList": {
    },
  • "chfInfo": {
    },
  • "chfInfoList": {
    },
  • "nefInfo": {
    },
  • "nrfInfo": {
    },
  • "udsfInfo": {
    },
  • "udsfInfoList": {
    },
  • "nwdafInfo": {
    },
  • "nwdafInfoList": {
    },
  • "pcscfInfoList": {
    },
  • "hssInfoList": {
    },
  • "customInfo": { },
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "nfServicePersistence": false,
  • "nfServices": [
    ],
  • "nfServiceList": {
    },
  • "nfProfileChangesInd": false,
  • "defaultNotificationSubscriptions": [
    ],
  • "lmfInfo": {
    },
  • "gmlcInfo": {
    },
  • "nfSetIdList": [
    ],
  • "servingScope": [
    ],
  • "lcHSupportInd": false,
  • "olcHSupportInd": false,
  • "nfSetRecoveryTimeList": {
    },
  • "serviceSetRecoveryTimeList": {
    },
  • "scpDomains": [
    ],
  • "scpInfo": {
    },
  • "seppInfo": {
    },
  • "vendorId": "string",
  • "supportedVendorSpecificFeatures": {
    },
  • "aanfInfoList": {
    },
  • "5gDdnmfInfo": {
    },
  • "mfafInfo": {
    },
  • "easdfInfoList": {
    },
  • "dccfInfo": {
    },
  • "nsacfInfoList": {
    },
  • "mbSmfInfoList": {
    },
  • "tsctsfInfoList": {
    },
  • "mbUpfInfoList": {
    },
  • "trustAfInfo": {
    },
  • "nssaafInfo": {
    },
  • "hniList": [
    ],
  • "iwmscInfo": {
    },
  • "mnpfInfo": {
    }
}

Deregisters a given NF Instance

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
nfInstanceID
required
string <uuid> (NfInstanceId)

Unique ID of the NF Instance to deregister

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Subscriptions (Collection)

Create a new subscription

Authorizations:
NoneoAuth2ClientCredentials
header Parameters
Content-Encoding
string

Content-Encoding, described in IETF RFC 7231

Accept-Encoding
string

Accept-Encoding, described in IETF RFC 7231

Request Body schema: application/json
required
nfStatusNotificationUri
required
string
reqNfInstanceId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

NfInstanceIdCond (object) or NfInstanceIdListCond (object) or NfTypeCond (object) or ServiceNameCond (object) or ServiceNameListCond (object) or (AmfCond (AmfCond (object) or AmfCond (object))) or GuamiListCond (object) or NetworkSliceCond (object) or NfGroupCond (object) or NfGroupListCond (object) or NfSetCond (object) or NfServiceSetCond (object) or UpfCond (object) or ScpDomainCond (object) or NwdafCond (object) or NefCond (object) or DccfCond (object) (SubscrCond)

Condition to determine the set of NFs to monitor under a certain subscription in NRF

validityTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

Array of strings or strings (NotificationEventType) non-empty
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

nid
string (Nid) ^[A-Fa-f0-9]{11}$

This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).

object (NotifCondition)

Condition (list of attributes in the NF Profile) to determine whether a notification must be sent by NRF

string or string (NFType)

NF types known to NRF

reqNfFqdn
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

Array of objects (ExtSnssai) non-empty
Array of objects (PlmnSnssai) non-empty
Array of objects (PlmnId) non-empty
Array of objects (PlmnIdNid) non-empty
servingScope
Array of strings non-empty
requesterFeatures
string^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

hnrfUri
string (Uri)

String providing an URI formatted according to RFC 3986.

onboardingCapability
boolean
Default: false
targetHni
string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?...

Fully Qualified Domain Name

preferredLocality
string

Responses

Callbacks

Request samples

Content type
application/json
{
  • "nfStatusNotificationUri": "string",
  • "reqNfInstanceId": "4e4239dd-f704-417c-8f75-4c673e439b68",
  • "subscrCond": {
    },
  • "validityTime": "2019-08-24T14:15:22Z",
  • "reqNotifEvents": [
    ],
  • "plmnId": {
    },
  • "nid": "string",
  • "notifCondition": {
    },
  • "reqNfType": "NRF",
  • "reqNfFqdn": "string",
  • "reqSnssais": [
    ],
  • "reqPerPlmnSnssais": [
    ],
  • "reqPlmnList": [
    ],
  • "reqSnpnList": [
    ],
  • "servingScope": [
    ],
  • "requesterFeatures": "string",
  • "hnrfUri": "string",
  • "onboardingCapability": false,
  • "targetHni": "string",
  • "preferredLocality": "string"
}

Response samples

Content type
application/json
{
  • "nfStatusNotificationUri": "string",
  • "reqNfInstanceId": "4e4239dd-f704-417c-8f75-4c673e439b68",
  • "subscrCond": {
    },
  • "subscriptionId": "string",
  • "validityTime": "2019-08-24T14:15:22Z",
  • "reqNotifEvents": [
    ],
  • "plmnId": {
    },
  • "nid": "string",
  • "notifCondition": {
    },
  • "reqNfType": "NRF",
  • "reqNfFqdn": "string",
  • "reqSnssais": [
    ],
  • "reqPerPlmnSnssais": [
    ],
  • "reqPlmnList": [
    ],
  • "reqSnpnList": [
    ],
  • "servingScope": [
    ],
  • "nrfSupportedFeatures": "string",
  • "hnrfUri": "string",
  • "onboardingCapability": false,
  • "targetHni": "string",
  • "preferredLocality": "string"
}

Callback payload samples

Callback
POST: {$request.body#/nfStatusNotificationUri}
Content type
application/json
{
  • "event": "NF_REGISTERED",
  • "nfInstanceUri": "string",
  • "nfProfile": {
    },
  • "profileChanges": [
    ],
  • "conditionEvent": "NF_ADDED",
  • "subscriptionContext": {
    }
}

Subscription ID (Document)

Updates a subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionID
required
string^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)...

Unique ID of the subscription to update

header Parameters
Content-Encoding
string

Content-Encoding, described in IETF RFC 7231

Accept-Encoding
string

Accept-Encoding, described in IETF RFC 7231

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "nfStatusNotificationUri": "string",
  • "reqNfInstanceId": "4e4239dd-f704-417c-8f75-4c673e439b68",
  • "subscrCond": {
    },
  • "subscriptionId": "string",
  • "validityTime": "2019-08-24T14:15:22Z",
  • "reqNotifEvents": [
    ],
  • "plmnId": {
    },
  • "nid": "string",
  • "notifCondition": {
    },
  • "reqNfType": "NRF",
  • "reqNfFqdn": "string",
  • "reqSnssais": [
    ],
  • "reqPerPlmnSnssais": [
    ],
  • "reqPlmnList": [
    ],
  • "reqSnpnList": [
    ],
  • "servingScope": [
    ],
  • "nrfSupportedFeatures": "string",
  • "hnrfUri": "string",
  • "onboardingCapability": false,
  • "targetHni": "string",
  • "preferredLocality": "string"
}

Deletes a subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subscriptionID
required
string^([0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)...

Unique ID of the subscription to remove

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}